home *** CD-ROM | disk | FTP | other *** search
/ Animation How-To / Animation How-to CD.iso / AAPLAYHI / AAPLAYHI.DOC < prev    next >
Text File  |  1994-01-01  |  70KB  |  1,708 lines

  1.                        Autodesk Animator Pro
  2.                         Player User's Guide
  3.                            (AAPLAYHI.EXE)
  4.  
  5.  
  6. This program and its support files can be freely distributed by you. 
  7. It is designed to let you deliver your presentations independently of 
  8. Autodesk Animator Pro. (Note: This program is functionally similar to 
  9. a licensed utility called aniplay.exe, but aaplayhi.exe is freely 
  10. distributable).
  11.  
  12. We would appreciate you giving copyright acknowledgement to Autodesk 
  13. somewhere in your presentation and have provided an opening credit 
  14. for this purpose. This screen may be suppressed if necessary (see 
  15. below). If you wish to include aaplayhi.exe as part of a commercial 
  16. software product, we would appreciate copyright acknowledgement in 
  17. the package and/or documentation.
  18.  
  19. The Autodesk Animator Pro Player is Copyright 1991, Autodesk, Inc.
  20.  
  21.  
  22. Table of Contents
  23. =================
  24.  
  25. 1.0   Introduction
  26. 2.0     Using a Mouse
  27. 3.0   Running in Interactive Mode
  28. 3.1     Menus
  29. 3.1.1     Selecting Menu Items
  30. 3.2   The File Selector
  31. 3.2.1     Using the Mouse in the File Selector
  32. 3.2.2     Using the Keyboard in the File Selector
  33. 3.2.3     Editing Text in Text Entry Blocks
  34. 3.2.4     The Plus Function
  35. 3.3   Playing Flics
  36. 3.3.1     Loading or Opening a Flic
  37. 3.3.2     Playing a Flic
  38. 3.3.3     Viewing Individual Frames
  39. 3.3.4     Changing a Flic's Speed
  40. 3.4   Loading and Displaying Pictures
  41. 3.4.1     .Gif and .Pcx Files
  42. 3.4.2     Other Picture and Animation Files
  43. 3.4.2.1     Picture Files
  44. 3.4.2.2     Animation Files
  45. 4.0   Scripting Mode
  46. 4.1   General Rules For Script Files
  47. 4.1.1     Comments
  48. 4.1.2     File and Path Descriptions
  49. 4.2   Playing a Script File
  50. 4.2.1     Keystrokes During Script Playback
  51. 4.2.2     Locking the Keyboard During Script Playback
  52. 4.3   Script Options and Commands
  53. 4.3.1     Options Affecting One File
  54. 4.3.1.1     Default Flic Playback
  55. 4.3.1.2     Default Picture Display
  56. 4.3.2     Loop, Speed, and Pause
  57. 4.3.3     Transitions
  58. 4.3.4     Picture Type
  59. 4.3.5     Commands Affecting More Than One File
  60. 4.3.5.1     Loop (count)
  61. 4.3.5.2     Break
  62. 4.3.5.3     Subroutines
  63. 4.3.5.4     Return
  64. 4.3.5.5     Call <script file and path>
  65. 4.3.5.6     Link <script file and path>
  66. 4.3.5.7     Keychoice
  67. 4.3.5.8     Loadflic <file and path>
  68. 4.3.5.9     Freeflic <file and path>
  69. 4.3.5.10    Exitscript
  70. 4.3.5.11    Exittoplayer
  71. 4.3.5.12    Exittodos
  72. 4.3.6     Script Limits
  73. 4.3.7     Script Error Messages
  74. 5.0   Special Configuration Options
  75. 6.0   Required Files
  76. 6.1   Font Files
  77. 6.2   Picture File Drivers
  78. 6.3   Display Drivers
  79. 6.4   Pointing Device Drivers
  80. 6.5   Other Files
  81. 6.5.1     AA.MU
  82. 6.5.2     AA.CFG
  83.  
  84.  
  85. 1.0 Introduction
  86. ================
  87.  
  88. The Autodesk Animator Pro Player program (aaplayhi.exe) is a flic 
  89. "projector" program that lets you play animations or display 
  90. pictures, either one at a time or following a text script file. By 
  91. using the sophisticated scripting capabilities, you can prepare and 
  92. present complex animated presentations, complete with variable screen 
  93. resolutions and keyboard-controlled menus.
  94.  
  95. Autodesk Animator Pro Player can display flic, anim cel, and image 
  96. files from Autodesk Animator Pro, Autodesk 3D Studio, Autodesk 
  97. Animator, and any other application that generates compatible files.
  98.  
  99. Autodesk Animator Pro Player adds many new features to those of 
  100. AAPLAY, the Autodesk Animator Player program. These features include:
  101.  
  102.      o - Loading and displaying .flc, .fli, .gif, .pcx, .seq,
  103.          .lbm, .rif, .mac, .sld, .tif, some .tga files and .cel
  104.          files (anim cel files from Autodesk Animator Pro).
  105.      o - Keyboard branching control during script playback.
  106.      o - Subroutines and script linking and calling.
  107.      o - Variable screen resolutions.
  108.      o - Special configuration options.
  109.  
  110.  
  111. 2.0 Using a Mouse
  112. =================
  113.  
  114. You can use Autodesk Animator Pro Player in the Interactive mode with 
  115. the keyboard or a Microsoft-compatible mouse. If you have never used 
  116. a mouse, please read this section for instructions. If you are 
  117. familiar with a mouse, you can skip this section.
  118.  
  119. When you move the mouse on your desk, a cursor moves on the screen. 
  120. You use this cursor to select items from menus or to activate options 
  121. on the Frames panel while Autodesk Animator Pro is in Interactive 
  122. mode.
  123.  
  124. The mouse has left and right buttons. In Autodesk Animator Pro 
  125. Player, there are several ways to operate these buttons:
  126.  
  127.    Click        Press and release the left button to select menu
  128.                 options and items on the Frames panel.
  129.    Right-click  Press and release the right button to cancel
  130.                 certain operations and to suppress menu and
  131.                 Frames panel display.
  132.    Drag         Press the left button and hold it down while
  133.                 moving the mouse.
  134.    Double-click Press and release the left button twice, quickly.
  135.  
  136.  
  137. 3.0 Running in Interactive Mode
  138. ===============================
  139.  
  140. To run Autodesk Animator Pro Player in Interactive mode:
  141.  
  142.     1. Go to the directory containing
  143.        Autodesk Animator Pro Player.
  144.  
  145.     2. Enter the following at the DOS prompt:
  146.  
  147.           aaplayhi
  148.  
  149. Result: A dialog box containing copyright information appears. Click 
  150. on Continue or press <CR> to continue. A black screen then appears 
  151. with a menu bar at the top and the Frames panel at the bottom.
  152.  
  153. Note: You can specify the video driver and the configuration file to 
  154. use when you run Autodesk Animator Pro Player. You can also use 
  155. Autodesk Animator Pro Player with either a Microsoft-compatible mouse 
  156. or the keyboard. If you have Autodesk Animator Pro, you can create a 
  157. special configuration file that lets Autodesk Animator Pro Player use 
  158. other pointing devices, such as a Summagraphics 1201 or Wacom 
  159. graphics tablet. See the "Autodesk Animator Pro Reference Manual" and 
  160. "Special Configuration Options" in section 5.0 for instructions on 
  161. how to create and use a configuration file.
  162.  
  163. To run Autodesk Animator Pro Player without having the copyright 
  164. dialog box appear, enter either of the following commands at the DOS 
  165. prompt:
  166.  
  167.           aaplayhi -a
  168.               or
  169.           aaplayhi -auto
  170.  
  171.  
  172. 3.1 Menus
  173. =========
  174.  
  175. When you start Autodesk Animator Pro Player without specifying a 
  176. script file on the command line, it is in Interactive mode and has 
  177. the following drop-down menus:
  178.  
  179.         The Player Menu
  180.      About       Displays information on Autodesk Animator Pro
  181.                  Player.
  182.      Memory      Displays information on current memory usage.
  183.      Quit        Exits Autodesk Animator Pro Player.
  184.  
  185.         The File Menu
  186.      Load Flic   Loads a flic into memory (if possible) and
  187.                  prepares it to be played.
  188.      Open Flic   Opens a flic without loading it into memory and
  189.                  prepares it to be played directly from the disk.
  190.      Load GIF    Loads a .gif picture onto the screen.
  191.      Load PCX    Loads a .pcx picture onto the screen.
  192.      Load Other  Brings up the Pick image format menu for you to
  193.                  select the type of file, then the file selector
  194.                  to load a picture file onto the screen.
  195.      Play Script Opens, scans for errors, and plays a script.
  196.      Screen Size Brings up the Screen Format menu for changing
  197.                  the screen driver and resolution (size).
  198.  
  199. Warning: All options on the File menu clear the computer's memory of 
  200. any files that may already have been loaded.
  201.  
  202.  
  203. 3.1.1 Selecting Menu Items
  204. ==========================
  205.  
  206. To select any menu item with the mouse, move the cursor over an item 
  207. in the menu bar, the banner across the top of the screen. A drop-down 
  208. menu appears; when you move the mouse away, the menu disappears.
  209.  
  210. To select a drop-down menu item with the mouse:
  211.  
  212.      1. Move the mouse onto the menu bar so that the cursor is
  213.         over a menu title. The menu title turns red and the menu
  214.         is displayed.
  215.  
  216.      2. Move the mouse over the list of items until the one you
  217.         want to select is outlined in red.
  218.  
  219.      3. Click on the item.
  220.  
  221.      4. To exit a menu without selecting an item, move the mouse
  222.         into the main area of the screen and the menu disappears.
  223.  
  224. To use the keyboard to select a drop-down menu item:
  225.  
  226.      o - On your keyboard, press either <P> for the Player menu or 
  227. <F> for the File menu. Then press the key corresponding to the first 
  228. letter of the menu item. Where the first letters of two or more menu 
  229. items are the same (such as Load Flic and Load GIF), another letter 
  230. is used, and the letter is usually underlined in the menu.
  231.  
  232. The keyboard equivalents of the various items are listed below.
  233.  
  234.         Player Menu <P>
  235.           About <A>
  236.           Memory <M>
  237.           Quit <Q>
  238.  
  239.         File Menu <F>
  240.           Load Flic <F>
  241.           Open Flic <O>
  242.           Load GIF <G>
  243.           Load PCX <X>
  244.           Load Other <L>
  245.           Play Script <P>
  246.           Screen Size <S>
  247.  
  248. For example, to select Load GIF from the File menu, press the <F> key 
  249. (to select the File menu), then the <G> key (to select Load GIF).
  250.  
  251.  
  252. 3.2 The File Selector
  253. =====================
  254.  
  255. When you select any function from the File menu other than Screen 
  256. Size, the file selector appears. You can use either the mouse or the 
  257. keyboard to select a file.
  258.  
  259.  
  260. 3.2.1 Using the Mouse in the File Selector
  261. ==========================================
  262.  
  263. To select a file with the mouse:
  264.  
  265. If the file you want is listed in the file window at the left of the 
  266. file selector, double-click on the file's name to select and load the 
  267. file. Another method is to click once on the filename (which appears 
  268. in the File field), then click on Load.
  269.  
  270. Files in the current directory are listed in the window at the left 
  271. of the file selector. Depending upon the function you choose from the 
  272. File menu, there will be two or more wildcard buttons that limit the 
  273. file list to those with matching filename extensions. For example, if 
  274. you choose Load Flic and Open Flic, there are four wildcard buttons. 
  275. You may choose to display all files (*.*), only Autodesk Animator Pro 
  276. files (*.FLC), only Autodesk Animator files (*.FLI) or both Autodesk 
  277. Animator Pro and Autodesk Animator files (*.FL?). Anim cel files use 
  278. the .cel extension and are not shown in the file selector when you 
  279. use the *.FLC, *.FLI, or *.FL? wildcard buttons. To see the names of 
  280. any available anim cel files, use the *.* wildcard button.
  281.  
  282. If there are more files than will fit in the window display, scroll 
  283. through the window by clicking on the up and down arrows in the 
  284. slider bar to the left of the window or by dragging the slider bar up 
  285. and down. (To drag, point the mouse at the slider, hold down the left 
  286. mouse button, and move the mouse. Release the button to release the 
  287. slider.)
  288.  
  289. If the file you want is located in another drive or directory, click 
  290. on the following icons:
  291.  
  292.      A:, B:, C:, etc. to go to another drive. Each drive you have
  293.                       is represented by a drive button.
  294.      \                to go to the root directory of the current
  295.                       drive.
  296.      ..               to go up one directory.
  297.  
  298. You can enter any directory listed in the file window by clicking on 
  299. that directory's name. (Directories are listed in the window preceded 
  300. by a backslash (\), for example, \FLICS.)
  301.  
  302. To exit the file selector (and take no further action), right-click 
  303. on the viewing screen or click on the Cancel button.
  304.  
  305.  
  306. 3.2.2 Using the Keyboard in the File Selector
  307. =============================================
  308.  
  309. There are two modes of keyboard entry when the file selector is on 
  310. screen: Keyboard Entry mode, and Keyboard Alternate mode.
  311.  
  312. Keyboard Entry mode lets you enter text. When the cursor in a 
  313. keyboard entry box is a solid box, you are in Keyboard Entry mode. 
  314. You can type text into the keyboard entry box, such as the path or 
  315. filename.
  316.  
  317. Keyboard alternate mode lets you select the current drive using the 
  318. keyboard. In Keyboard Alternate mode, keys you press perform 
  319. selections on the file selector in much the same way as pointing with 
  320. a mouse. To enter Keyboard Alternate mode, press the <Tab> key until 
  321. the cursor is in the directory or wildcard keyboard entry box, then 
  322. press <CR>. The box cursor becomes a thin, vertical line, as the 
  323. cursors in the other two keyboard entry boxes appear.
  324.  
  325. In the Keyboard Alternate mode, you can change the current drive by 
  326. pressing the key corresponding to the drive letter. For example, to 
  327. change the current drive to drive E, press the <E> key (using either 
  328. lower- or uppercase letters).
  329.  
  330. You can also change the current directory by pressing <.> (the period 
  331. key) to move up one directory, or the backslash (\) key to move to 
  332. the root directory of the current drive.
  333.  
  334.  
  335. 3.2.3 Editing Text in Text Entry Blocks
  336. =======================================
  337.  
  338. While you are in Keyboard Entry mode, you can use the following keys 
  339. to edit text:
  340.  
  341.      <Esc>          Clears the keyboard entry box.
  342.      <Delete>       Deletes the letter under the cursor.
  343.      <Backspace>    Deletes the letter to the left of the cursor.
  344.      <Left arrow>   Moves the cursor to the left.
  345.      <Right arrow>  Moves the cursor to the right.
  346.      <Home>         Moves the cursor to the start of the text.
  347.      <End>          Moves the cursor to the end of the text.
  348.      <CR>           Accepts the text.
  349.  
  350. Note: When entering the name of a file to load or open, you must 
  351. enter the complete name, including the filename extension.
  352.  
  353.  
  354. 3.2.4 The Plus Function
  355. =======================
  356.  
  357. The plus function changes the current filename by removing the 
  358. seventh and eighth characters, if they exist, and substituting two 
  359. digits for them. If the current filename ends in a number, the new 
  360. digits will be one higher. If the current filename does not end in a 
  361. number, the plus function starts its numbering at 01.
  362.  
  363. For example, if the current filename is box.flc, the new filename 
  364. after using the plus function will be box01.flc. If you attempt to 
  365. load a file named, say, filename.flc, and inadvertently use the plus 
  366. function, Autodesk Animator Pro Player will search for a file named 
  367. filena01.flc.
  368.  
  369. The plus function is especially useful for creating, loading, or 
  370. opening a series of sequentially numbered files.
  371.  
  372. If you are using a mouse, click on the + button to use the plus 
  373. function.
  374.  
  375. If you are using the keyboard, you must be in Keyboard Alternate mode 
  376. to use the plus function. Press the keypad <+> or the <Shift-+> 
  377. keyboard combination.
  378.  
  379.  
  380. 3.3 Playing Flics
  381. =================
  382.  
  383. This section describes how to use a mouse or the keyboard to load and 
  384. play a flic or anim cel, view individual frames, and change a flic's 
  385. speed.
  386.  
  387.  
  388. 3.3.1 Loading or Opening a Flic
  389. ===============================
  390.  
  391. In Autodesk Animator Pro Player, you can either load or open a flic 
  392. file. If you load a flic file, Autodesk Animator Pro Player loads as 
  393. much of the file as it can into memory. This will achieve the fastest 
  394. playback speed. If you open a flic rather than load it, Autodesk 
  395. Animator Pro loads into memory only as much of the file as it needs 
  396. to manage the playback. When you play the file, Autodesk Animator Pro 
  397. Player takes each frame's information from the disk as needed.
  398.  
  399. Note: Autodesk Animator Pro and Autodesk Animator flics are designed 
  400. to be played from a hard disk or a RAM disk. If you play them from a 
  401. floppy disk drive, the animation speed is very slow.
  402.  
  403. To load a flic using a mouse, select Load Flic from the File menu and 
  404. follow the procedure described in section 3.2.1, "Using the Mouse in 
  405. the File Selector."
  406.  
  407. After you have loaded a flic, it will appear on the screen with the 
  408. menu bar and the Frames panel. You can now view individual frames, 
  409. play the flic, change the flic's speed, load another flic, and exit 
  410. Autodesk Animator Player. You can toggle the menu bar and Frames 
  411. panel by right-clicking on the viewing screen.
  412.  
  413. To open a flic using a mouse, select Open Flic from the File menu and 
  414. follow the procedure described in section 3.2.1, "Using the Mouse in 
  415. the File Selector."
  416.  
  417. Note: You can also load Autodesk Animator Pro anim cel files, using 
  418. the Load Flic options or open them using the Open Flic option. 
  419. Autodesk Animator .cel files cannot be loaded into Autodesk Animator 
  420. Pro Player.
  421.  
  422. To load a flic or anim cel file using the keyboard:
  423.  
  424.      1. Press <F> (to select File), and then press <F> again (to
  425.         select Load Flic).
  426.  
  427. Result: The file selector appears in Keyboard Entry mode. If desired, 
  428. you can exit the file selector (and take no further action) by 
  429. pressing <Esc> twice.
  430.  
  431.      2. Press <Esc> to clear the field, then type in the name of
  432.         your flic or anim cel file, including the filename
  433.         extension.
  434.  
  435.      3. Press <CR> to load the flic.
  436.  
  437. Result: The first frame of the flic appears on screen to indicate 
  438. that it is ready to be played.
  439.  
  440. If the flic is located in another drive, do this:
  441.  
  442.      1. Press <Tab> until the cursor is in the Dir field.
  443.  
  444.      2. Press <Esc> to clear the field.
  445.  
  446.      3. Enter the flic's path name (for example,
  447.         c:\directory\filename).
  448.  
  449. You can also switch to Keyboard Alternate mode and change the current 
  450. directory using Keyboard Alternates. See section 3.2.2, "Using the 
  451. Keyboard in the File Selector."
  452.  
  453. After you have loaded a flic, it appears on the screen with menu 
  454. displays that let you view individual frames, play the flic, change 
  455. the flic's speed, load another flic, and exit Autodesk Animator Pro 
  456. Player. You can toggle the menu displays on or off by pressing the 
  457. spacebar.
  458.  
  459.  
  460. 3.3.2 Playing a Flic
  461. ====================
  462.  
  463. At the bottom of the screen is the Frames panel. At the top of the 
  464. Frames panel is the playback bar, which lets you view individual 
  465. frames or play the entire flic or anim cel. You can move the Frames 
  466. panel by clicking on the Frames button. The Frames panel will 
  467. disappear, leaving a marquee box. Move the marquee box where you want 
  468. it with the mouse and click again to place it. If you want the Frames 
  469. panel to return to the bottom of the screen, right-click on the 
  470. Frames button.
  471.  
  472. To play the entire flic or anim cel using the mouse, do this:
  473.  
  474.      1. Click on the double-arrows.
  475.  
  476. Result: The menu bar and Frames panel disappear and the flic or anim 
  477. cel plays through.
  478.  
  479.      2. To stop the flic or anim cel, right-click on the viewing
  480.         screen.
  481.  
  482. Result: The flic or anim cel stops and the menu and the Frames panel 
  483. reappear.
  484.  
  485. To play the entire flic or anim cel a flic using the keyboard, do 
  486. this:
  487.  
  488.      1. Press the <down arrow> key.
  489.  
  490. Result: The menu bar and Frames panel disappear and the flic or anim 
  491. cel plays through.
  492.  
  493.      2. To stop the flic or anim cel, press the <down arrow> key 
  494. again.
  495.  
  496. The following keys control playback in the Interactive mode:
  497.  
  498.      Key           Action
  499.      <Down arrow>  Plays the flic; while playing, pauses playback.
  500.      <Up arrow>    Moves to first frame.
  501.       or <Home>
  502.      <End>         Moves to last frame.
  503.      <Spacebar>    Toggles menu bar and Frames panel on and off.
  504.  
  505. In addition, the following keys offer additional controls:
  506.  
  507.      Key           Action
  508.      <Q> or <Esc>  Brings up the Quit dialogue box (while no
  509.                    flic is playing).
  510.      <Ctrl-C>      Aborts the current script during script
  511.                    playback and returns you to the menu bar.
  512.      Any other key Halts the play of a flic or anim cel.
  513.  
  514.  
  515. 3.3.3 Viewing Individual Frames
  516. ===============================
  517.  
  518. The slider bar in the Frames panel also lets you view individual 
  519. frames of a flic. With a mouse, you can click on these icons to 
  520. perform the following actions:
  521.  
  522.      Icon          Action
  523.      Down arrow    Moves to last frame.
  524.      Left arrow    Moves back one frame.
  525.      Right arrow   Moves forward one frame.
  526.      Up Arrow      Moves to first frame.
  527.      Number box    In upper slider bar, drags to desired frame.
  528.      Double arrows Plays entire flic or anim cel.
  529.  
  530. Click within the numbered bar in the Frames panel to jump to another 
  531. frame in the animation. For example, clicking on the right side of 
  532. the numbered bar takes you to a frame nearer to the end of the flic, 
  533. while clicking to the left takes you to a frame nearer to the 
  534. beginning of the flic.
  535.  
  536. To view individual frames using the keyboard, first toggle the menu 
  537. bar and Frames panel off by pressing the spacebar. Then use the left 
  538. and right cursor arrow keys to move through the flic or anim cel one 
  539. frame at a time:
  540.  
  541.      Key           Action
  542.      <Left arrow>  Moves back one frame.
  543.      <Right arrow> Moves forward one frame.
  544.  
  545.  
  546. 3.3.4 Changing a Flic's Speed
  547. =============================
  548.  
  549. The slider bar at the bottom of the Frames panel controls the flic's 
  550. playback speed. The numbered bar represents the duration of pause for 
  551. each frame, measured in "jiffies" or 1/70 second. A lower speed 
  552. setting plays the flic faster, a higher speed setting slows the flic 
  553. down. To change a flic's speed, click on the left or right arrows to 
  554. adjust the speed by single increments or drag the bar to a desired 
  555. speed.
  556.  
  557. The speed you set is temporary. After you exit the flic, the original 
  558. speed settings return.
  559.  
  560. You can also use the keyboard to control playback speed. Press the 
  561. keypad or keyboard <-> (minus or hyphen) key to increase the play 
  562. speed (decrease the time each frame is displayed) by single 
  563. increments; press the keypad <+> (plus) key or the <Shift><+> key 
  564. combination to decrease the play speed (increase the time each frame 
  565. is displayed) by single increments.
  566.  
  567. Both mouse and keyboard users can use the following keys to control 
  568. speed during the playback:
  569.  
  570.      Function Key   Speed in Jiffies
  571.      F1             0
  572.      F2             3
  573.      F3             6
  574.      F4             9
  575.      F5             12
  576.      F6             18
  577.      F7             24
  578.      F8             36
  579.      F9             48
  580.      F10            Sets to speed specified in the file.
  581.  
  582.  
  583. 3.4 Loading and Displaying Pictures
  584. ===================================
  585.  
  586.  
  587. 3.4.1 .Gif and .Pcx files
  588. =========================
  589.  
  590. You can also load other animation and image files into Autodesk 
  591. Animator Pro Player. On the File menu, there are specific items for 
  592. loading .gif and .pcx pictures. To load a .gif picture using a mouse, 
  593. select Load GIF from the File menu, either with the mouse or by 
  594. pressing the <F> key and then the <L> key. Then follow the procedures 
  595. described in section 3.2.1, "Using the Mouse in the File Selector," 
  596. or in section 3.2.2, "Using the Keyboard in the File Selector."
  597.  
  598. After you have loaded a picture, it will appear on the screen. 
  599. Because a picture file is a still image rather than an animation, it 
  600. will only have one "frame." To view a picture without the menu bar or 
  601. Frames panel, right-click on the viewing screen.
  602.  
  603. To load a .pcx picture using a mouse, follow the same procedure; 
  604. however, begin by choosing Load PCX from the File menu, rather than 
  605. Load GIF.
  606.  
  607.  
  608. 3.4.2 Other Picture and Animation Files
  609. =======================================
  610.  
  611. Using the Load Other menu option from the File menu, you may also 
  612. load and display other picture and animation files into Autodesk 
  613. Animator Pro Player. Picture files consist of a single image, while 
  614. animation files have more than one image in sequence.
  615.  
  616. Note: Autodesk Animator Pro Player loads only the first frame of non-
  617. flic animation files.
  618.  
  619.  
  620. 3.4.2.1 Picture Files
  621. =====================
  622.  
  623. Autodesk Animator Pro Player loads the following types of picture 
  624. files in addition to .gif  and .pcx files:
  625.  
  626. DEGAS (Atari ST DEGAS .pi? and .pc? picture files)
  627. LBM (Amiga and IBM Deluxe Paint III, etc. .lbm picture files)
  628. MAC (Macintosh .mac monochrome picture files)
  629. NEO (Atari ST NEOchrome .neo picture files)
  630. SLD (AutoCAD .sld picture files)
  631. TARGA (Autodesk 3D Studio and other .tga and .pix picture files)
  632. TIFF (Tag Image File Format .tif picture files)
  633.  
  634.  
  635. 3.4.2.2 Animation Files
  636. =======================
  637.  
  638. Autodesk Animator Pro Player loads the first frame of the following 
  639. types of animation files in addition to Autodesk Animator .fli, and 
  640. Autodesk Animator Pro .flc and anim cel .cel files:
  641.  
  642. RIF (Amiga Zoetrope and Live! .rif animation files)
  643. SEQ (Atari ST Cyber .seq animation files)
  644. ANIM (Amiga Anim, Deluxe Paint III .ani animation files)
  645.  
  646. If you want to load the entire animation into Autodesk Animator Pro 
  647. Player, you must first use the Autodesk Animator Pro Converter to 
  648. convert it to a .flc or .fli file.
  649.  
  650. To load a picture or animation file using a mouse:
  651.  
  652.      1. Select Load Other from the File menu. The Pick image
  653.         format to load selector appears. If desired, you can exit
  654.         this selector (and take no further action) by right-
  655.         clicking on the viewing screen or by clicking on the
  656.         Cancel button.
  657.  
  658.      2. Choose the image format you want to load. You may select
  659.         it by double-clicking on it or by clicking on it and then
  660.         clicking on the Load button. To read the characteristics
  661.         of a particular file type, click on its name and then
  662.         click on the Info button. A window appears listing the
  663.         characteristics of that file type.
  664.  
  665. Once you have selected the image format you want, the file selector 
  666. appears. If desired, you can exit this selector by right-clicking on 
  667. the viewing screen or clicking on the Cancel button. Follow the 
  668. procedure described in "Using the Mouse in the File Selector," or in 
  669. "Using the Keyboard in the File Selector" to select an appropriate 
  670. file to load.
  671.  
  672. After you have loaded a picture, it will appear on the screen. 
  673. Because a picture file is a still image rather than an animation, it 
  674. has only one "frame." 
  675.  
  676. To view a picture without the menu bar or Frames panel, right-click 
  677. on the viewing screen.
  678.  
  679. To load a picture or animation file in one of the listed formats 
  680. using the keyboard:
  681.  
  682.      1. You must not have a mouse driver installed. If you do,
  683.         remove it and reboot your computer.
  684.  
  685.      2. Follow the instructions listed above for selecting a file
  686.         using a mouse. In place of the mouse, use the cursor
  687.         arrow keys to position the cursor, the left <Shift> as
  688.         the left mouse button, and the right <Shift> as the right
  689.         mouse button.
  690.  
  691.  
  692. 4.0 Scripting Mode
  693. ==================
  694.  
  695. A script file is a text script containing a list of flics and/or 
  696. pictures to display in succession. Think of a picture as a single-
  697. frame animation, which you can load and display individually by 
  698. selecting Load .GIF, Load .PCX or Load Other from the File menu. In 
  699. script mode, you can display a picture file and leave it on the 
  700. screen for a specified number of seconds.
  701.  
  702. You can write a script file with any text editor or word processor 
  703. that produces a standard ASCII (or DOS text) file. Script files can 
  704. be created in Autodesk Animator or Autodesk Animator Pro, if desired. 
  705. To do so, use the Text tool to enter the script text. Choose a font 
  706. that is easy to read in the Text Edit window for the screen 
  707. resolution you are using.
  708.  
  709. Also, be sure that the font you use includes the hyphen (-) you need 
  710. for specifying certain parameters (e.g., -t). From within the Text 
  711. Tool, save the script in a text file (e.g., myscript.scr). Then, when 
  712. you exit Autodesk Animator or Autodesk Animator Pro, you can load 
  713. this text file into Autodesk Animator Pro Player as a script file.
  714.  
  715. Autodesk Animator Pro Player uses the filename extender .scr for 
  716. script files. However, you can give a script file any filename and/or 
  717. extension.
  718.  
  719. Caution: The native file format of most word processors is not ASCII 
  720. and does not work as a script file. However, most word processors 
  721. have the ability to save text in ASCII format.
  722.  
  723.  
  724. 4.1 General Rules for Script Files
  725. ==================================
  726.  
  727. At its simplest level, a script file that plays three flics and a 
  728. picture in sequence looks like this:
  729.  
  730.      d:bldg.flc
  731.      c:\flics\juke.flc
  732.      c:\pics\dunes.gif
  733.      d:sign.flc
  734.  
  735. If you do not specify any options in a script, the same script could 
  736. also be used in Flitape and Flipaper, as well as in Autodesk Animator 
  737. Pro Player. The result would be radically different, of course. 
  738. However, once you add any options to the script lines, the 
  739. commonality ends.
  740.  
  741. Caution: As a general rule, however, do not attempt to use a script 
  742. from Autodesk Animator Pro Player in Flitape or Flipaper, or to use a 
  743. script from one of those programs in Autodesk Animator Pro Player. At 
  744. best, the results may be unexpected or cause an error that stops the 
  745. program; at worst, you may lose some of your work.
  746.  
  747. Notice that you must specify the full filename and extension for each 
  748. flic or picture, unless the file is in a drive's current path. 
  749. Autodesk Animator Pro Player will set the current path to the same 
  750. directory as that of the script. In the above example, if the script 
  751. shown is in the same directory on drive d: as bldg.flc and sign.flc, 
  752. the program will locate those files even if you don't specify the 
  753. directory and subdirectories.
  754.  
  755. Every discrete "word" of a script line must be separated by white 
  756. space, although the amount of white space is up to you. Also, you may 
  757. insert blank lines in between script lines in order to group and 
  758. order your scripts. In this context, a word can be a filename and 
  759. path, a command, or a number. The double slashes (//) indicate that 
  760. comments follow. See "Comments" in the next section.
  761.  
  762. A filename and path are treated as one word, and you can use any 
  763. mixture of upper- or lowercase letters to create a script file. In 
  764. addition, you can list parameters after the flic filenames in any 
  765. order:
  766.  
  767.      flic1.flc -s 2 -l 3 -t fadein
  768.  
  769. is exactly the same as the combination of upper- and lowercase:
  770.  
  771.      FLIC1.FLC -l 3 -T FADEin -S 2
  772.  
  773. For some parameters, you may use a period "." or a set of 
  774. parentheses, ( and ), to set them off from the other words on the 
  775. line. For example, the command "color" takes three arguments:
  776.  
  777.      color(0,255,0)
  778.  
  779. Arguments must be set off by beginning and ending parentheses and be 
  780. separated by commas, but without a trailing comma after the last 
  781. argument.
  782.  
  783.  
  784. 4.1.1 Comments
  785. ==============
  786.  
  787. You may add comments to a script file by inserting two slash 
  788. characters (//). Anything after these characters is ignored by the 
  789. program. For example:
  790.  
  791.      d:\flics\testfile.flc // This is a comment.
  792.      d:\pictures\greatpic.gif // This is
  793.      // another comment.
  794.  
  795. Comments are very helpful in designing and organizing your 
  796. presentation, particularly before you become totally conversant in 
  797. the scripting language. Similarly, comments can be very helpful to 
  798. others who may need to use and understand your script at some later 
  799. point.
  800.  
  801.  
  802. 4.1.2 File and Path Descriptions
  803. ================================
  804.  
  805. When Autodesk Animator Pro Player runs, it checks the current paths 
  806. for all devices. It remembers these paths as the current paths for 
  807. all fixed devices, such as hard disks or CD-ROM drives. For floppy 
  808. drives, however, the current path is assumed to be the root (e.g. a:\ 
  809. or b:\).
  810.  
  811. When you run a script, the current directory changes to that of the 
  812. script while the script is running. For example, if you run Autodesk 
  813. Animator Pro Player from the c:\ani\ directory and call a script from 
  814. the d:\present1\ directory, Autodesk Animator Pro Player will set the 
  815. current path for your hard disk to the d:\present1\ directory while 
  816. the script is running and reset it to c:\ani when it is finished 
  817. running.
  818.  
  819. Using the previous example, if you wanted to include the flic 
  820. d:\present1\intro.flc in your presentation, you would only need to 
  821. list its path as d:intro.flc. However, in general, it's almost always 
  822. safer to include the specific path when listing a file.
  823.  
  824. If you load flics or pictures from floppy disks, you must make sure 
  825. that each file has a unique name. There is no way for the Autodesk 
  826. Animator Pro Player to know the difference between a flic called 
  827. a:\myflic.flc and a different flic also called a:\myflic.flc on a 
  828. different floppy disk. Autodesk Animator Pro Player stores the 
  829. filename for each path in RAM, but can only store a single name for 
  830. each. For example, if you load a:\myflic.flc from one floppy and then 
  831. load a second a:\myflic.flc, Autodesk Animator Pro Player will remove 
  832. the first flic from the computer's memory before loading the second.
  833.  
  834.  
  835. 4.2 Playing a Script File
  836. =========================
  837.  
  838. You can play a script file in one of two ways. For example, if you 
  839. want to play the script named present1.scr, you have these 
  840. alternatives:
  841.  
  842.      o - In Interactive mode, select Play Script from the File menu,
  843.          and then select present1.scr from the file selector.
  844.      o - From the DOS prompt, enter the following command:
  845.  
  846.           aaplayhi present1
  847.  
  848. Note: If the script file has an extension other than .scr, you must 
  849. include it on the Autodesk Animator Pro Player command line.
  850.  
  851. When you start a script by including its name on the command line, as 
  852. in the above axample, before the script plays, a dialog box appears 
  853. with Autodesk copyright information. To play the script, click on the 
  854. Continue box or press <CR>.
  855.  
  856. If you want your script to begin without showing the copyright dialog 
  857. box, add -a or -auto to the command line that starts the script. For 
  858. example, to suppress the dialog box while playing the script called 
  859. present1.scr, enter the following:
  860.  
  861.           aaplayhi present1 -a
  862.  
  863. In the four-file script example shown at the beginning of the Scripts 
  864. section, the first two animations each play through once, the GIF 
  865. picture is displayed for 5 seconds, and then the last animation plays 
  866. through once. At the end of the last animation, you are returned to 
  867. the DOS prompt if that is where you started, or to the Autodesk 
  868. Animator Pro Player screen if you started it from the Autodesk 
  869. Animator Pro Player.
  870.  
  871. Along with the program name and script filename, you may also include 
  872. on the command line one or more special configuration options that 
  873. control the program configuration, the display driver and its display 
  874. mode. See section 5.0, "Special Configuration Options," 
  875.  
  876. Note: Because of the time taken to decompress them, .gif pictures 
  877. display relatively slowly, sweeping down the screen as they appear. 
  878. We recommend that you make your .gif pictures into flic frames, then 
  879. load the flic from the script file. (If desired, use a slow playback 
  880. speed for a slide-projector effect.)
  881.  
  882.  
  883. 4.2.1 Keystrokes During Script Playback
  884. =======================================
  885.  
  886. There are a number of ways to control the playback of a script with 
  887. the keyboard:
  888.  
  889.      o - You can lock the keyboard. See the next section, "Locking 
  890.          the Keyboard During Script Playback."
  891.      o - You can define a specific set of keys that control the
  892.          progress of the script using the keychoice command. See
  893.          section 4.3.5.7, "Keychoice".
  894.      o - You can press any of the following (assuming the
  895.          keyboard is not locked and that none of these keys has
  896.          been used to lock the keyboard:
  897.  
  898.       Key         Action
  899.      <Esc>        Breaks out of script loop; see below. Aborts
  900.                   keychoice if at choice point; returns to
  901.                   previous keychoice, if any, or aborts to DOS or
  902.                   interactive mode, if none.
  903.      <Ctrl-C>     Aborts the current script.
  904.    Any other key
  905.    or right-click Proceeds to the next file; if during fade-in,
  906.                   aborts right-click fade-in and goes to next
  907.                   image. If during flic playback or pause, aborts
  908.                   current action and starts fade-out, if any.
  909.  
  910. Unless the keyboard is locked, these keystrokes affect only the flic 
  911. currently playing. Thus if a keystroke breaks out of the current 
  912. flic's loop, the next flic listed in the script file immediately 
  913. begins playback. If the speed is altered by the keyboard during the 
  914. cycle of one flic, the following flic in the script file reverts to 
  915. its programmed speed.
  916.  
  917.  
  918. 4.2.2 Locking the Keyboard During Script Playback
  919. =================================================
  920.  
  921. A keyboard lock is a command you enter to render the keyboard 
  922. inactive until the next time you enter the same keyboard combination. 
  923. You can use a keyboard lock any time a script of animations and/or 
  924. pictures is running. It is designed to keep curious fingers from 
  925. halting your demonstrations.
  926.  
  927. To lock the keyboard, do this:
  928.  
  929.      1. Hold down the <Ctrl> key and press any alphabetical key
  930.         (<A>-<Z>), with the exception of <Ctrl-C>.
  931.  
  932. Result: A dialogue box appears asking you to confirm that you want to 
  933. lock the keyboard with that key combination. If you do, click on Yes 
  934. or press <Y>. To cancel the keyboard lock, click on No, right-click 
  935. or press <N> or <Esc>.
  936.  
  937. Caution: Be sure to remember which key lock you chose! Check the 
  938. dialogue box to make sure that the key combination shown is the one 
  939. you want. If you forget, the only way to exit is to reset your 
  940. computer by pressing <Ctrl>, <Alt>, and <Delete> simultaneously. (Or 
  941. you could try every letter in the alphabet while holding down the 
  942. <Ctrl> key!)
  943.  
  944.      2. To unlock the keyboard, hold down <Ctrl> and press the
  945.         same key. A dialogue box appears advising you that you
  946.         are canceling the keyboard lock. Press any key or click
  947.         on Continue to proceed.
  948.  
  949.  
  950. 4.3 Script Options and Commands
  951. ===============================
  952.  
  953. 4.3.1 Options Affecting One File
  954. ================================
  955.  
  956. The options affecting a single flic or picture in a script are 
  957. controlled by adding a particular parameter in the script line after 
  958. the name of the flic or picture file. These parameters consist of a 
  959. hyphen followed by a code letter or word specifying the speed, the 
  960. number of loops, the type of transition between files, whether the 
  961. last frame is held on screen and the file type of a picture file. 
  962.  
  963. These are the available options:
  964.  
  965.      Option         Action
  966.      -l (x)         Loops flic; x is the number of times a flic 
  967.                     plays (must be an integer)
  968.      -s (y)         Sets playback speed for flic; y is the number 
  969.                     of jiffies (1/70 second) per frame
  970.      -p (z)         Pauses flic at the end; z is the pause time 
  971.                     in seconds (can be decimal)
  972.      -t (options)   Transitions (fade-ins, fade-outs and cuts); 
  973.                     options include the type of transition,
  974.                     whether it is an in transition or out
  975.                     transition, and the time in which the
  976.                     transition is to occur (can be decimal or
  977.                     integer)
  978.      -type (pdr load type)  Specifies the type of picture to
  979.                     load; pdr is the filename of the picture
  980.                     driver; do not include the filename
  981.                     extension .pdr
  982.  
  983. You can list any combination-or none-of these parameters after each 
  984. listed filename in your script file. Autodesk Animator Pro Player can 
  985. accept a script line of up to 255 characters long.
  986.  
  987.  
  988. 4.3.1.1 Default Flic Playback
  989. =============================
  990.  
  991. If no parameters are listed after a flic filename, the default flic 
  992. playback is a single loop at the speed specified by the file with no 
  993. pause on the last frame and no transitions (a clean cut from one flic 
  994. to the next). If you specify a loop control value of 0, the flic will 
  995. play indefinitely or until it is interrupted by a key press.
  996.  
  997.  
  998. 4.3.1.2 Default Picture Display
  999. ===============================
  1000.  
  1001. If no parameters are listed after a picture filename, the default 
  1002. picture display has a duration of 5.0 seconds with a cut to the next 
  1003. picture or animation.
  1004.  
  1005.  
  1006. 4.3.2 Loop, Speed, and Pause
  1007. ============================
  1008.  
  1009. Loop, speed, and pause parameters are simply a matter of listing the 
  1010. parameter letter followed by its control, separated by a space:
  1011.  
  1012. flic1.flc -l 3 -s 6
  1013. // Plays three times at a speed of six jiffies per frame.
  1014. flic2.flc -s 3
  1015. // Plays once at a speed of three jiffies per frame.
  1016. flic3.flc -l 2
  1017. // Plays twice at the speed set in the file.
  1018. pic1.gif -p 10.3
  1019. // Displays the picture for 10.3 seconds.
  1020. flic4.flc -p 8
  1021. // Plays the flic once and holds the last frame for 8 seconds.
  1022.  
  1023. Note: Loop (-l) and speed (-s) parameters have no effect on picture 
  1024. files.
  1025.  
  1026. If you want a single flic to loop, it's more efficient to use the -l 
  1027. loop parameter than to use the script loop control. See section 
  1028. 4.3.5.1,"Loop (count)".
  1029.  
  1030.  
  1031. 4.3.3.Transitions
  1032. =================
  1033.  
  1034. Transitions are fades to or from a one-colored screen, and they 
  1035. require one or two options following the parameter to describe the 
  1036. type of transition at the beginning and end of the flic playback. The 
  1037. default transition is a straight cut (i.e., a switch from one image 
  1038. or animation to another). You can also specify the time over which 
  1039. the transition is to occur after the type of transition.
  1040.  
  1041. The default color for cuts and fade-outs is black. If you want to 
  1042. specify a fade to or from a color other than black, you can list its 
  1043. RGB (red, green, and blue) component values in parentheses after the 
  1044. command color. You can also specify the color white by name, rather 
  1045. than as color (255,255,255). If you specify a color other than black 
  1046. for a fade-out and then follow that with a fade-in without specifying 
  1047. a color, the fade-in will be from the color you specified. As an 
  1048. example of this, note the transitions from flic2 to flic3 in the 
  1049. following sequence:
  1050.  
  1051. flic1.flc -t fadein color (255,0,0) fadeout color (0,0,0)
  1052. //    Fade in from red, fade to black.
  1053. flic2.flc -t cut fadeout 1.5 white
  1054. //    Cut from black, fade to white over 1.5 sec.
  1055. flic3.flc -t fadein 1.0 cut
  1056. //    Fade in from white over 1.0 seconds, cut to flic4.
  1057. flic4.flc -t fadeout
  1058. //    Cut from flic3, fade to black.
  1059. flic5.flc -t fadein
  1060. //    Fade in from black, cut to black.
  1061. pic1.gif -t fadein 0.5 -p 3.0
  1062. //    Fade in from black over 0.5 sec, hold for 3.0 sec, then cut to 
  1063. flic6.
  1064. flic6.flc
  1065. //    Cut from pic1, cut out - no transition options are necessary.
  1066.  
  1067. Each color is described by a combination of its RGB components in 
  1068. range from 0 (0%) to 255 (100%). Pure white is composed of 100% red, 
  1069. 100% green and 100% blue, or (255,255,255). Pure red is (255,0,0); 
  1070. pure green is (0,255,0) and pure blue is (0,0,255). Other colors are 
  1071. specified by the combination of different RGB values.
  1072.  
  1073. The timing for fade-ins and fade-outs is specified in seconds and 
  1074. tenths of seconds. If no time is specified, the fade takes place over 
  1075. 0.8 seconds. If you specify a fade time of 0 seconds, the result is a 
  1076. cut. Cuts occur as fast as the system speed allows.
  1077.  
  1078. There are usually several ways of defining a transition. For example, 
  1079. if you want to fade in from white over a time of 0.8 seconds and fade 
  1080. out over one second, you may define this transition in any of the 
  1081. following ways:
  1082.  
  1083. flic1.flc -t fadein 0.8 white fadeout 1 color(255,255,255) 
  1084. flic1.flc -t fadein color(255,255,255) fadeout 1 white
  1085. flic1.flc -t fadein white fadeout color(255,255,255) 1
  1086.  
  1087. Similarly, a fade-in from white over 0.8 seconds can be defined by 
  1088. any of the following:
  1089.  
  1090. flic1.flc -t fadein white
  1091. flic1.flc -t fadein cut color(255,255,255) 
  1092. flic1.flc -t fadein color(255,255,255) cut
  1093. flic1.flc -t fadein 0.8 color(255,255,255)
  1094. flic1.flc -t fadein white .8
  1095. flic1.flc -t fadein 00.8 color(255,255,255) cut
  1096. flic1.flc -t fadein white .8 cut
  1097.  
  1098.  
  1099. 4.3.4 Picture Type
  1100. ==================
  1101.  
  1102. You may specify the type of still picture to load by using the -type 
  1103. parameter after the filename. If you do not specify a picture type, 
  1104. Autodesk Animator Pro Player first attempts to load the file as a 
  1105. flic, then as a .gif file, and finally as a .pcx file. If it can't 
  1106. load the file as any of those, an 
  1107. error results.
  1108.  
  1109. If you want to load a type of picture other than the default, you 
  1110. must specify its file type using the -type parameter:
  1111.  
  1112. c:\pictures\opening.tif -type tiff
  1113. e:\targas\gears.tga -type targa
  1114. d:\ani\gifs\lake.gif
  1115.  
  1116.  
  1117. 4.3.5 Commands Affecting More Than One File
  1118. ===========================================
  1119.  
  1120. There are also a number of options in Autodesk Animator Pro Player to 
  1121. control the playback of groups of flics and/or pictures. Autodesk 
  1122. Animator Pro Player lets you define a group of flics and pictures as 
  1123. a subroutine, so that any time you want to play through that group, 
  1124. you need only name it in the script. Also, Autodesk Animator Pro 
  1125. Player lets you start one script, leave it to play another, and then 
  1126. return to the first, all under program control. Moreover, Autodesk 
  1127. Animator Pro Player lets you play a series of scripts, moving from 
  1128. one to the next automatically. Autodesk Animator Pro Player lets you 
  1129. set up a menu system using a wide range of key choices to control the 
  1130. flow and direction of your presentation. Finally, Autodesk Animator 
  1131. Pro Player lets you determine what happens when your presentation 
  1132. plays through completely.
  1133.  
  1134. These are the available scripting commands:
  1135.  
  1136.      Command        Effect
  1137.      Loop (count)   Repeats portion of script within loop, count
  1138.                     times.
  1139.      Break          Aborts loop and proceeds to next script
  1140.                     command.
  1141.      Subroutines    Means of organizing and modularizing scripts;
  1142.                     called using the gosub command.
  1143.      Return         Returns program to main script from
  1144.                     subroutine
  1145.      Call <script file & path>   Transfers program control to new
  1146.                     script file; returns to original after run.
  1147.      Link <script file & path>   Transfers program control to new
  1148.                     script file; does not return to original.
  1149.      Keychoice      Method of setting up keyboard-controlled
  1150.                     actions during script playback.
  1151.      Loadflic <file & path>      Loads flic file into computer
  1152.                     memory for later playback.
  1153.      Freeflic <file & path>      Releases flic from computer
  1154.                     memory.
  1155.      Exitscript     Exits current script.
  1156.      Exittoplayer   Exits script and goes to Interactive mode.
  1157.      Exittodos      Exits script and returns to DOS or
  1158.                     Interactive mode.
  1159.  
  1160.  
  1161. 4.3.5.1 Loop (count)
  1162. ==================
  1163.  
  1164. This command tells Autodesk Animator Pro Player to loop (repeat) a 
  1165. set of instructions the number of times specified by the parameter 
  1166. count. Each loop begins with the command loop and ends with the 
  1167. command endloop. The parameter count must be an integer value greater 
  1168. than one (or the word forever) enclosed in parentheses. Forever 
  1169. causes the loop to continue until you exit the script. You may nest 
  1170. loops up to five deep.
  1171.  
  1172. For example:
  1173.  
  1174. loop (forever) // Start main loop which will play until stopped.
  1175.      intro.flc // Play first flic.
  1176.      flic2.flc // Play second flic.
  1177.      loop(4) // Start second loop, to play through four times.
  1178.           pic1.gif -p 3 // Show pic1 for 3 sec.
  1179.           pic2.tif -type tiff -p 2
  1180.           // Load TIFF driver, show pic2 for 2 sec.
  1181.           pic3.gif -p 4 // Show pic3 for 4 sec.
  1182.      endloop // The end of the inside loop.
  1183.      epilog.flc // Play the final flic.
  1184. endloop // End of the outside loop;
  1185. // return to the outer loop and start over.
  1186.  
  1187. Suggestion: The indenting shown in the above example is a matter of 
  1188. style only, but it tends to make a script easier to follow.
  1189.  
  1190. Note: You can use the loop command to play a single flic more than 
  1191. once, but it is more efficient to use the -l option.
  1192.  
  1193.  
  1194. 4.3.5.2 Break
  1195. =============
  1196.  
  1197. If Autodesk Animator Pro Player is playing a script in a loop and it 
  1198. encounters a break command, it will abort the loop and continue 
  1199. playing the script from the point after the endloop for that loop. 
  1200. The primary purpose of the break command is for use within keychoice 
  1201. lists to specify a choice that will terminate a loop. See section 
  1202. 4.3.5.7,"Keychoice".
  1203.  
  1204. If Autodesk Animator Pro Player encounters a break command outside a 
  1205. loop, an error results.
  1206.  
  1207.  
  1208. 4.3.5.3 Subroutines
  1209. ===================
  1210.  
  1211. Subroutines are script modules, or small "chunks" of script, that you 
  1212. can define to include almost any instruction to Autodesk Animator Pro 
  1213. Player. Once you have defined a subroutine, you can run it at any 
  1214. point in the script with the command gosub <module name>. This 
  1215. command lets you simplify your main script and place all your 
  1216. repeatable modules in separate locations at the end of the script.
  1217.  
  1218. To define a subroutine, you mark its beginning with the word 
  1219. subroutine followed by its name on the same line. The end of a 
  1220. subroutine is marked by the word endsub. All subroutines must be 
  1221. defined at the end of the main script; in fact, the word subroutine 
  1222. tells Autodesk Animator Pro Player that it has reached the end of the 
  1223. main script. There is a limit to the number of subroutines you can 
  1224. have, but in practical terms, you need never approach it. See section 
  1225. 4.3.6, "Script Limits".
  1226.  
  1227. A subroutine can consist of a single line or multiple lines, and you 
  1228. can call a subroutine any number of times within a script. A 
  1229. subroutine can't call itself, however, nor can you define a 
  1230. subroutine within another subroutine. The following is not valid:
  1231.  
  1232. . . .
  1233. <end of main script>
  1234. subroutine sub1 // Begin the definition of subroutine sub1.
  1235.      flic1.flc // Part of sub1.
  1236.      subroutine sub2 // Begin definition of subroutine sub2;
  1237.      // This is an error!
  1238.           flic2.flc // Part of sub2.
  1239.      endsub // End of sub2.
  1240. endsub // End of sub1.
  1241.  
  1242.  
  1243. 4.3.5.4 Return
  1244. ==============
  1245.  
  1246. If Autodesk Animator Pro Player encounters a return command while in 
  1247. a subroutine, it will immediately stop the subroutine and return to 
  1248. the main script. This is very useful for branching control. If 
  1249. Autodesk Animator Pro Player encounters a return command not in a 
  1250. subroutine, it is treated as an exitscript; see section 4.3.5.10, 
  1251. "Exitscript".
  1252.  
  1253.  
  1254. 4.3.5.5 Call <script file and path>
  1255. ===================================
  1256.  
  1257. Another method for organizing a script is to place portions in a 
  1258. second script and then call it from the first script. If Autodesk 
  1259. Animator Pro Player comes upon a call <script file and path> command, 
  1260. it will open the second script, follow the commands there, and then 
  1261. when it has finished the second script, return to the location from 
  1262. which it left the first script. You must include the path of the 
  1263. called script in the command, unless it is in the same path as the 
  1264. current script.
  1265.  
  1266. Note: If the called script includes an exittodos or exittoplayer 
  1267. command, Autodesk Animator Pro Player will follow that command and 
  1268. abort the called script and all other scripts.
  1269.  
  1270.  
  1271. 4.3.5.6 Link <script file and path>
  1272. ===================================
  1273.  
  1274. Like call <script file and path>, the link <script file and path> 
  1275. command transfers control from the current script to a second script. 
  1276. Unlike the call command, link does not return to the first script 
  1277. (the caller) when the second script is finished.
  1278.  
  1279. Before starting the second script, Autodesk Animator Pro Player 
  1280. clears all flics and pictures from memory.
  1281.  
  1282. If you link from one script to another, it is possible to link back 
  1283. to the first script by including a link in the last script directing 
  1284. Autodesk Animator Pro Player back to the first. Autodesk Animator Pro 
  1285. Player will not return to where it left the first script; instead, it 
  1286. will restart the first script from the beginning.
  1287.  
  1288.  
  1289. 4.3.5.7 Keychoice
  1290. =================
  1291.  
  1292. The keychoice command is one of the most powerful commands in 
  1293. Autodesk Animator Pro Player. It lets you set up a branching 
  1294. presentation and define the keyboard control available during 
  1295. playback. If Autodesk Animator Pro Player encounters a keychoice 
  1296. command, it monitors the keyboard during the playback of a flic or 
  1297. picture. If the user presses one of the keys you have defined as 
  1298. valid for that point, it immediately performs the commands you 
  1299. defined.
  1300.  
  1301. The list of keychoices is marked at the start by the word keychoice 
  1302. and at the end by the word endchoice. In between, each choice is 
  1303. defined by the word choice, followed by a key. There must be at least 
  1304. one choice in a keychoice list. Keys available for choices include 0 
  1305. through 9 and a through z. Autodesk Animator Pro Player does not 
  1306. distinguish between upper- and lowercase, so a and A are the same 
  1307. keychoice. You may use the same key in more than one keychoice list.
  1308.  
  1309. A command that displays a picture or plays a flic must come 
  1310. immediately before a keychoice command. If you want to have a flic 
  1311. play continuously until a keychoice is made, use the -l 0 option to 
  1312. provide an infinite play loop. If you want to play a flic and pause 
  1313. on the last frame until a keychoice is made, Autodesk Animator Pro 
  1314. Player will do so automatically at the end of any flic that precedes 
  1315. a keychoice command.
  1316.  
  1317. If you specify a pause in the flic preceding a keychoice, and that 
  1318. pause time has passed, any fade-out or cut you've specified for that 
  1319. flic will take place. Autodesk Animator Pro Player will then resume 
  1320. the script immediately after the endchoice command for the keychoice 
  1321. immediately following the flic or picture display specification.
  1322.  
  1323. After the commands defined under a choice have been performed, 
  1324. Autodesk Animator Pro Player continues playing the script from the 
  1325. point immediately after the endchoice.
  1326.  
  1327. Here's an example of how to use keychoice:
  1328.  
  1329. intro.flc // Play first flic.
  1330. menu1.flc // Play second flic, a menu.
  1331. keychoice // The start of the first keychoice list.
  1332.      choice 1 // What happens if you press 1
  1333.           flic3.flc
  1334.      choice E // What happens if you press E.
  1335.           flickee.flc
  1336.      choice 2 // What happens if you press 2.
  1337.           flic5.flc
  1338.      choice escape // What happens if you press the Escape key.
  1339.           exittodos // Exits play, returns to DOS or menus.
  1340. endchoice // The end of the keychoice list.
  1341.  
  1342. Autodesk Animator Pro Player monitors keys other than the keychoices 
  1343. while a keychoice flic or picture is displayed. If you want to lock 
  1344. out any keys other than the defined keychoices, you may lock the 
  1345. keyboard, as described in section 4.2.2, "Locking the Keyboard During 
  1346. Script Playback."
  1347.  
  1348. Keychoices may also be nested, one set inside another.
  1349.  
  1350.  
  1351. 4.3.5.8 Loadflic <file and path>
  1352. ================================
  1353.  
  1354. The loadflic command is used to load a flic into memory for faster 
  1355. playback. You can use the loadflic command anywhere within a script, 
  1356. but you must play the flic somewhere in the script. The loadflic 
  1357. command will be useful only if you have sufficient memory available. 
  1358. If there is not enough memory to load the flic or flics, you will be 
  1359. asked in turn if you want to play each directly from the disk. If you 
  1360. answer Yes, that flic will play from the disk in turn. If you answer 
  1361. No, the program will abort.
  1362.  
  1363. You may load several flics if you have sufficient memory to do so. 
  1364. You must, however, play them all within the script. If you fail to do 
  1365. so, an error will result. Here is an example of loading two flics:
  1366.  
  1367. . . .
  1368. loadflic d:\flics\flic1.flc
  1369. loadflic d:\flics\flic2.flc
  1370. . . .
  1371.  
  1372. You may also use loadflic to load a flic from a floppy disk. When 
  1373. Autodesk Animator Pro Player encounters a command such as this:
  1374.  
  1375. . . .
  1376. loadflic a:\flic1.flc
  1377. . . .
  1378.  
  1379. it will ask you to insert the disk in the drive. After doing so, 
  1380. click on Continue in the dialogue box. The script will abort if no 
  1381. disk is present in the indicated drive. If no memory is available for 
  1382. loading a file from a floppy disk, the script will be aborted.
  1383.  
  1384. Specify the full path for the file, as Autodesk Animator Pro Player 
  1385. disregards the current path both when it scans the syntax at first 
  1386. and later when it loads the file; the path a:flic1.flc is interpreted 
  1387. as a:\flic1.flc. The floppy disk containing the flic must be in the 
  1388. drive when the script is started.
  1389.  
  1390. Important: Memory usage can't be fully estimated when the script is 
  1391. scanned during the syntax check pass. The only way to make sure a 
  1392. script will have all the memory it needs is to run it in its 
  1393. entirety.
  1394.  
  1395.  
  1396. 4.3.5.9 Freeflic <file and path>
  1397. ================================
  1398.  
  1399. The freeflic command removes the named flic from memory if it has 
  1400. been loaded; it is the reverse of loadflic. If the flic is not in 
  1401. memory, an error message appears telling you that the flic was never 
  1402. loaded. The program then aborts. All flics in memory are freed when 
  1403. the script exits or transfers control to another script via the link 
  1404. command. You must include the same path to free a flic as you used in 
  1405. the loadflic command. Example:
  1406.  
  1407. . . .
  1408. freeflic d:\flics\flic1.flc
  1409. freeflic d:\flics\flic2.flc
  1410. . . .
  1411.  
  1412.  
  1413. 4.3.5.10 Exitscript
  1414. ===================
  1415.  
  1416. The exitscript command is used to exit a script playback; it's like 
  1417. reaching the end of the current script. If Autodesk Animator Pro 
  1418. Player encounters an exitscript command in a script called via the 
  1419. call command, it will stop playing it and return to the script that 
  1420. called it. For example, if Script1 calls Script2, and Autodesk 
  1421. Animator Pro Player encounters an exitscript command in Script2, it 
  1422. will return to Script1 and continue playing at the point immediately 
  1423. after the command that called Script2.
  1424.  
  1425. If Autodesk Animator Pro Player encounters an exitscript command in a 
  1426. linked script or a stand-alone script, it treats the exitscript 
  1427. command as an equivalent to exittodos. For example, if Script1 is 
  1428. linked to Script2 and Autodesk Animator Pro Player encounters an 
  1429. exitscript command in either script, it quits the script it's in and 
  1430. exits.
  1431.  
  1432. 4.3.5.11 Exittoplayer
  1433. =====================
  1434.  
  1435. The exittoplayer command is used to exit a script and return to the 
  1436. Interactive mode of Autodesk Animator Pro Player. Note that this 
  1437. command is all one word, with no spaces.
  1438.  
  1439.  
  1440. 4.3.5.12 Exittodos
  1441. ==================
  1442.  
  1443. The exittodos command is used to exit a script and return to the mode 
  1444. of Autodesk Animator Pro Player from which the script was played. If 
  1445. the script were played using the Play Script command on the File menu 
  1446. in the Interactive mode, the exittodos command would return you to 
  1447. that point. If, however, the script were played from the DOS prompt, 
  1448. you would be returned to DOS. Note that this command is all one word, 
  1449. with no spaces.
  1450.  
  1451.  
  1452. 4.3.6 Script Limits
  1453. ===================
  1454.  
  1455. Every script played by Autodesk Animator Pro Player is allowed 24 
  1456. levels of Loops, Gosubs, and Keychoices, combined. If you attempt to 
  1457. nest more than 24 levels, you will receive the error message "Out of 
  1458. stack space." You can avoid this error by dividing your script into 
  1459. several smaller scripts, as each script has its own separate script 
  1460. limit. You can then use the call or link commands to transfer control 
  1461. from script to script.
  1462.  
  1463.  
  1464. 4.3.7 Script Error Messages
  1465. ===========================
  1466.  
  1467. If you have made a typing mistake in your script file, or included an 
  1468. instruction the Autodesk Animator Pro Player does not understand, a 
  1469. message similar to the following appears:
  1470.  
  1471.      Error in scriptfile
  1472.  
  1473.          "d:\present1\present.scr"
  1474.          line 10
  1475.          Unable to display "d:\present1\flic7.flc".
  1476.  
  1477.  
  1478.          File not found. (File name misspelled?)
  1479.  
  1480. The last four lines of the message may change, depending on the 
  1481. error. The line number displayed is the line that most probably 
  1482. contains the error. Examine the lines closely for an error, then 
  1483. correct it and retry the script.
  1484.  
  1485. Note: In some cases the error might have occurred somewhere other 
  1486. than in the indicated line. If you can't find an error in the noted 
  1487. line, examine your entire script file carefully for a mistake. If you 
  1488. still can't find it, use a process of elimination by first making a 
  1489. backup copy of the script file, and then deleting certain lines until 
  1490. the script file works.
  1491.  
  1492.  
  1493. 5.0 Special Configuration Options
  1494. =================================
  1495.  
  1496. Important: If Autodesk Animator Pro Player is run from the same 
  1497. directory as Autodesk Animator Pro or Autodesk Animator Pro 
  1498. Converter, changing the Screen Size from within Autodesk Animator Pro 
  1499. Player overwrites any existing aa.cfg file. The next time you run 
  1500. Autodesk Animator Pro or Autodesk Animator Converter without 
  1501. specifying a different configuration file, it will read the aa.cfg 
  1502. file created by Autodesk Animator Pro Player and configure itself 
  1503. accordingly.
  1504.  
  1505. If you wish to avoid having Autodesk Animator Pro Player overwrite 
  1506. your aa.cfg file, you can either run it from another directory or 
  1507. specify a path and filename for Autodesk Animator Pro Player's 
  1508. configuration file when you run it. In the first instance, for 
  1509. example, if Autodesk Animator Pro Player is in the c:\aapc\ directory 
  1510. and this directory is on the DOS path, you may start Autodesk 
  1511. Animator Pro Player from any directory on your system. Autodesk 
  1512. Animator Pro Player will then create an aa.cfg file in the directory 
  1513. where it is run, rather than the directory where the executable 
  1514. (aniplay.exe) is located. If you run it from a directory called 
  1515. d:\wp51\, Autodesk Animator Pro Player will create the file 
  1516. d:\wp51\aa.cfg file.
  1517.  
  1518. If you want to specify the configuration file for Autodesk Animator 
  1519. Pro Player to use, type the following at the DOS prompt (assuming 
  1520. either that you are in the Autodesk Animator Pro Player directory or 
  1521. that you have added the directory to the DOS path):
  1522.  
  1523.      aaplayhi -cfg path\filename
  1524.  
  1525. You may also use -c in place of -cfg. For example, if you wished to 
  1526. use a configuration file you have renamed to aapp.cfg in the ani 
  1527. directory on the c: drive, you would type the following to start 
  1528. Autodesk Animator Pro Player:
  1529.  
  1530.      aaplayhi -c c:\ani\aapp.cfg
  1531.  
  1532. If you do not specify a path, Autodesk Animator Pro Player will look 
  1533. in the current directory.
  1534.  
  1535. You may also specify that Autodesk Animator Pro Player use a specific 
  1536. display driver when you start the program. At the DOS prompt, type:
  1537.  
  1538.      aaplayhi -drv path\filename mode number
  1539.  
  1540. You may also use -d in place of -drv. For example, if you wished to 
  1541. use the VESA driver in its mode 1 (720X540), you would type the 
  1542. following at the DOS prompt:
  1543.  
  1544.      aaplayhi -d vesa 1
  1545.  
  1546. Modes can be determined by examining the Screen Format menu. In the 
  1547. scrolling list of display drivers, the mode number is listed directly 
  1548. following the driver name. For example, mode 0 for vesa.drv is 
  1549. 640X400, mode 1 is 720X540, etc. You do not need to include the 
  1550. filename extender .drv; Autodesk Animator Pro Player assumes that 
  1551. this is the extension when it looks for the driver. You must, 
  1552. however, include a mode number.
  1553.  
  1554. Autodesk Animator Pro Player only looks for display drivers in a 
  1555. subdirectory called resource in the directory in which the program 
  1556. was installed. For example, if aniplay.exe is in the directory 
  1557. c:\aniplay, Autodesk Animator Pro Player will only look for drivers 
  1558. in the directory c:\aniplay\resource. The installation program 
  1559. automatically creates a directory called resource and places all 
  1560. display drivers in it as part of the installation. If you add any 
  1561. display drivers to Autodesk Animator Pro Player, be sure to place 
  1562. them in this directory.
  1563.  
  1564. You may combine both configuration and display driver switches on the 
  1565. same line:
  1566.  
  1567.      aaplayhi -c c:\ani\aapp.cfg -d vesa 2
  1568.  
  1569. Be sure to leave spaces in the command line as shown above.
  1570.  
  1571. If Autodesk Animator Pro Player cannot locate the driver you specify 
  1572. in the command, it looks to see which driver is called for in the 
  1573. aa.cfg file and attempts to load that driver. If Autodesk Animator 
  1574. Pro Player can't locate that driver either, it will attempt to use 
  1575. its internal 320X200 MCGA/VGA driver.
  1576.  
  1577.  
  1578. 6.0 Required Files
  1579. ==================
  1580.  
  1581. Depending upon how Autodesk Animator Pro Player is installed, it can 
  1582. be placed in its own directory or in a directory with other 
  1583. executable programs. If you install Autodesk Animator Pro Player in 
  1584. the same directory as Autodesk Animator Pro, the two programs (and 
  1585. the Autodesk Animation Converter program) can share a single set of 
  1586. resource files.
  1587.  
  1588. In addition to the executable file, aaplayhi.exe, Autodesk Animator 
  1589. Pro Player requires the files listed below. Autodesk Animator Pro 
  1590. Player will look first to see if there is a directory named resource 
  1591. within its current directory. If so, it will look first for the 
  1592. required files in that directory. If there is no directory named 
  1593. resource within its directory, Autodesk Animator Pro Player looks 
  1594. next in the ani directory for the necessary files. If Autodesk 
  1595. Animator Pro Player can't find the required files in either location, 
  1596. a message is displayed indicating that it can't find the resource 
  1597. directory.
  1598.  
  1599. Not all of the listed files are not required for every operation; 
  1600. some are only used for specific functions. Those files required for 
  1601. general operation of Autodesk Animator Pro Player are noted.
  1602.  
  1603.  
  1604. 6.1 Font Files
  1605. ==============
  1606.  
  1607. These files are used to display menu and dialogue text on the screen 
  1608. in medium- and high-resolution modes. Depending upon the resolution 
  1609. chosen, one of the following fonts may be necessary. In 320X200 
  1610. resolution, Autodesk Animator Pro Player uses its own internal font.
  1611.  
  1612.      Font File      Horizontal Screen Resolution
  1613.      AAMENU.FNT     500X to 799X
  1614.      AAHRMENU.FNT   800X and over
  1615.  
  1616.  
  1617. 6.2 Picture File Drivers
  1618. ========================
  1619.  
  1620. These files are external drivers to let Autodesk Animator Pro Player 
  1621. load a wide variety of image and animation file types. You will only 
  1622. require the drivers for the specific file formats you are using.
  1623.  
  1624.      Picture
  1625.      File Driver    File Type
  1626.      ANIM.PDR       Autodesk Animator Pro standard .flc animation
  1627.                     files
  1628.      DEGAS.PDR      Atari ST DEGAS .pi? and DEGAS Elite .pc?
  1629.                     picture files
  1630.      FLILORES.PDR   Autodesk Animator .fli animation files
  1631.      GIF.PDR        Autodesk Animator Pro-standard image .gif
  1632.                     picture files
  1633.      LBM.PDR        Amiga and PC Deluxe Paint III, etc. .lbm
  1634.                     picture files
  1635.      MAC.PDR        Macintosh .mac monochrome picture files
  1636.      NEO.PDR        Atari ST NEOchrome .neo picture files
  1637.      PCX.PDR        PC Paint and other .pcx picture files
  1638.      RIF.PDR        Amiga Zoetrope and Live! .rif animation files
  1639.      SEQ.PDR        Atari ST Cyber .seq animation files
  1640.      SLD.PDR        AutoCAD .sld picture files
  1641.      TARGA.PDR      Autodesk 3D Studio and other .tga and .pix
  1642.                     picture files
  1643.      TIFF.PDR       Tagged Image File Format, .tif picture files
  1644.  
  1645. Note: Autodesk Animator Pro Player can only load certain types of 
  1646. Targa files, i.e., those with no more than eight bits of color 
  1647. information per pixel. If you want to load and display a "truecolor" 
  1648. .tga or .pix file (one with more than eight bits of color per pixel) 
  1649. into Autodesk Animator Pro Player, you must first convert the file 
  1650. into an eight-bit Targa file in Autodesk Animator Pro Converter.
  1651.  
  1652.  
  1653. 6.3 Display Drivers
  1654. ===================
  1655.  
  1656. These files are required to configure the Autodesk Animator Pro 
  1657. Player display output to specific display adapters.
  1658.  
  1659.      Display Driver    Application
  1660.      AADISP.DRV        320X200 standard VGA display
  1661.      COMPAQ.DRV        For the Compaq Advanced VGA display
  1662.      VESA.DRV          For VGA and Super VGA cards that comply
  1663.                        with the VESA standard
  1664.      8514A.DRV         For the Panacea Panamate 8514/A display
  1665.  
  1666. Note: If you are using the VESA driver, you may also need a utility 
  1667. program to configure your particular display card. See the Autodesk 
  1668. Animator Pro Installation and Performance Guide for further details.
  1669.  
  1670.  
  1671. 6.4 Pointing Device Drivers
  1672. ===========================
  1673.  
  1674. These files are used to adapt the Autodesk Animator Pro Player 
  1675. control system to the specific pointing device you are using.
  1676.  
  1677.      Pointing
  1678.      Device Driver     Application
  1679.      MMOUSE.IDR        Microsoft Mouse and 100% compatibles
  1680.      KEY.IDR           Keyboard
  1681.      SUMMA.IDR         Summagraphics graphics tablet
  1682.      WACOM.IDR         Wacom graphics tablet
  1683.  
  1684.  
  1685. 6.5 Other Files
  1686. ===============
  1687.  
  1688.  
  1689. 6.5.1 AA.MU
  1690. ===========
  1691.  
  1692. This file contains the text of all menus, dialogues and messages in 
  1693. Autodesk Animator Pro Player.
  1694.  
  1695.  
  1696. 6.5.2 AA.CFG
  1697. ============
  1698.  
  1699. This is the configuration file created in Autodesk Animator Pro, 
  1700. Autodesk Animator Pro Converter, and Autodesk Animator Pro Player. 
  1701. Autodesk Animator Pro Player will write a new aa.cfg file whenever 
  1702. you change the screen size. If you run Autodesk Animator Pro Player 
  1703. from the same directory as either Autodesk Animator Pro or Autodesk 
  1704. Animator Pro Converter, and an Autodesk Animator Pro aa.cfg file 
  1705. exists in that directory, Autodesk Animator Pro Player will read the 
  1706. existing aa.cfg file and configure itself similarly. This includes 
  1707. such items as menu colors, screen size, and the pointing device used.
  1708.